Get list of vehicles

This request returns a list of the client's registered vehicles with the option to filter by user and other parameters. Supports page-by-page navigation and the option to include deleted vehicles.

Request syntax

GET https://b2b-api.go.yandex.ru/integration/2.0/vehicles/list?order_id=<ride request identifier>&
limit=<number of records> 
&cursor=<mark from previous request>&
user_id=<user identifier>&
include_deleted=false

Request headers

  • Authorization: Bearer <OAuth-token>
    OAuth access token. The steps to get a token are described in Getting started.
  • X-YaTaxi-Selected-Corp-Client-Id — client ID from the account. Required if multiple clients are available using the token.

Request parameters

Request contains the following required parameter:

  • order_id — client ID.

The request may contain the following optional parameters:

  • limit — number of displayed entries. If this parameter is missing, information about the first 100 entries is returned.
  • cursor — request marker (returned in the response body to the previous request). The parameter is not required to request the first page, but is required to request subsequent pages.
  • user_id — user ID (for filtering).
  • include_deleted — include deleted (archived) cars. Default: false.

Response fields description

The response is returned in JSON format and contains a paginated list of vehicles.

Field Description Format
items An array of objects with data for each vehicle. Array
limit Limit requested on the page. Number
cursor Cursor for the next page (if any). String
total_amount Total number of suitable vehicles. Number
all_client_vehicles Total number of client's vehicles. Number

Request example

GET https://b2b-api.go.yandex.ru/integration/2.0/vehicles/list?client_id=client-001&limit=10&include_deleted=false
Authorization: Bearer <OAuth token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>

Response example

"items": [
  {
    "vehicle_id": "7ea0b....75e9",
    "license_plate": "М200ММ199",
    "model": "Gazelle Next",
    "limit": {
        "limit_id": "7715b673f2....39c9b0d4b6",
        "service": "tanker",
        "title": "Daily limits",
        "fuel_types": [
            "metan"
        ],
        "limits": {
            "orders_cost": {
                "value": "1000",
                "period": "month",
                "kind": "money"
            }
        }
    },
    "created_at": "2022-11-21T14:36:27.369997+00:00",
    "access_type": "custom",
    "is_deleted": false,
    "drivers": {
        "total_count": 0,
        "users": [],
        "departments": []
    }
  }
]

Possible response codes

  • 200 — success
  • 400 — invalid request parameters
  • 403 — access forbidden
Previous
Bulk deletion of vehicles
Next
Business trips